Configuration and Version History Management of Entities
The Version Generator in Palette establishes the version history for all the entities and generates the configuration packages when a user checks in the configured data. The entities are added to Configuration packages, Version history and Release Management.
The configuration package nodes includes the entity nodes, each containing a version history node. All the entities in Open Configuration Packages are available with a Remove from Package option. A user can right click and select this option to remove a particular configuration package from that entity node.
Version History Management of Entities
When a user creates a new entity or modifies the data of an entity and checkin the node, the user can specify the configuration package to which the entity data should be added. Palette adds a Version History folder for the entity under its Data folder and a sibling node to the entity's Data file. This Version History folder lists all the versions of an entity's data modification history.
In Palette, the Open Configuration Packages under Release Management in Admin Explorer and the Configuration Packages in Main Explorer presents the configuration packages as shown below (shows configuration packages for a Company). A user can click and expand the configuration package to view all the entities that are included in that configuration package along with its version history details.
The Version History folder lists all the versions of the entity's data modification history. Each version historynode is labeled with the VersionNumber, the timestamp at which the version was saved in a mm/dd/yyyy hh:mm:ss.ms format, and the ClientNumber that saved the version along with the entity name.
Each node under Version History has an option to Revert to this Version, and a user can click this option to revert to the version. If a version is reverted to the prior version, version history corresponding to this also is created. A user can refresh the version history node and view the details.
When there is any creation of a new entity or change to the entity data, Palette saves the current state of an entity's data to IvsVersion, IvsVersionHistory, and IvsVersionField tables.
Company, IvsCodeRuleType =36
When a Company is created or when there is any change to the Company's dynamic data, the changes are captured in version history and added to a configuration package as an XML document. A user can checkout to modify the Company data, and select the configuration package to which the captured version history can be added. Palette persists the current state of Company data to IvsVersion, IvsVersionHistory, and IvsVersionField tables as described below.
IvsVersion
The table saves the following details for a Company:
| Field Name | Description |
| RuleGUID | CompanyGUID is saved as RuleGUID. |
| VersionNumber | For every change of an entity data, the VersionNumber value is incremented. |
| RuleTypeCode | The code value for IVSCodeRuleType. For Company, the RuleTypeCode is '36'. |
| LastModifiedBy | The user's ClientNumber that has modified the entity. |
| LastModifiedGMT | The current GMT time at which the entity was modified. |
IvsVersionHistory
The table saves the following details for a Company:
| Field Name | Description |
| VersionGUID |
The associated VersionGUID from IvsVersion is saved in this table's VersionGUID. |
| RuleGUID | ID of the rule for an entity. For Company, the CompanyGUID is saved as RuleGUID. |
| Environment | Contains the Environment value. |
| Track | Contains the Track value. |
| ActionTypeCode | The code value of an appropriate IvsCodeActionType is saved to the ActionTypeCode column. |
| LastModifiedBy | The user's ClientNumber that has modified the entity. |
| LastModifiedGMT | The current GMT time at which the entity was modified. |
IvsVersionField
In this table, each column of AsCompany is saved as a separate record. The record contains an associated VersionGUID from IvsVersion which is saved in the table's VersionGUID; the column names are saved as the FieldName values.
The following columns from AsCompany are saved in IvsVersionField:
| Field Names | Description |
| CompanyGUID, CompanyName, ClientGUID, DefaultCurrencyCode, MarketMakerGUID, CalendarCode |
The values are saved in the TextValue column (FieldTypeCode = 02) |
| EffectiveDate |
The values are saved in the DateValue column (FieldTypeCode = 01) |
| CompanyField | The values are saved to the XMLDataValue column (FieldTypeCode = 05) |
CompanyFields
A Company record that consists of multiple AsCompanyField records are placed in an XML document as follows:
<CompanyData>
<CompanyFields>
<Field>
<Name>[field name]</Name>
<FieldTypeCode>[field type code]</FieldTypeCode>
<Value>[field value]</Value>
<CurrencyCode>[code value]</CurrencyCode>
<OptionText>[option text value]</OptionText>
<OptionTextFlag>[integer]</OptionTextFlag>
</Field>
<Field>...</Field>
</CompanyFields>
</CompanyData>
|
Element and Attribute Description of <CompanyData>
| Element | Parent Element | Description | Values |
| <CompanyData> |
Opening element for version history of Company Data. |
||
| <CompanyFields> | <CompanyData> |
Required: Opening element for the defined fields of the Company Data. |
|
| <Field> | <CompanyFields> |
Required, Repeatable: The opening element for a single field. There is one for each defined field. |
|
| <Name> | <Field> |
Required: The configured name of a defined field. |
Field name |
| <FieldTypeCode> | <Field> |
Required: Identifies the data type column for the field. |
Code value from ASCodeField |
| <Value> | <Field> |
Required: Provides data for the field from the DateValue, TextValue, IntValue, FloatValue or BigTextValue column as identified by the <FieldTypeCode>. |
Field's value
|
| <CurrencyCode> | <Field> |
Required: The currency code value for a field defined as data type Money. When the field is not defined as a Money data type, the saved value should be null. |
Currency code from AsCurrency |
| <OptionText> | <Field> |
Required: The field's option text value associated to the field's data value. This is applicable for fields of Combo or Radio data types. The value is null for fields not of these types or for that no selection has been made. |
Option text value |
| <OptionTextFlag> | <Field> |
Required: A value indicates a number for the option that was selected. |
Integer |
Error Catalog
When an Error Catalog is edited, a configuration package is generated and the version history is displayed under the Release Management in Admin Explorer; and under the Configuration Packages in Main Explorer.
Enrollment Transaction, IvsCodeRuleType = 43
When an Enrollment Transaction node is checked in, the current state of the data is saved to IvsVersion, IvsVersionHistory and IvsVersionField tables. If a specific enrollment transaction node is deleted, this is captured as an action in a configuration package.
IvsVersion
The table saves the following details for Enrollment Transaction:
- A concatenation of ProductGUID, "_" and TransactionGUID is saved as the RuleGUID.
- VersionNumber, RuleTypeCode, ClientNumber, LastModifiedBy and LastModifiedGMT. For column descriptions, refer IvsVersion table.
IvsVersionHistory
The table saves VersionGUID, RuleGUID, Environment, Track, ActionTypeCode, LastModifiedBy, and LastModifiedGMT details of an Enrollment Transaction. For column descriptions, refer IvsVersionHistory table.
IvsVersionField
In this table, each column from AsEnrollmentTransaction is saved as a separate record. The record contains an associated VersionGUID from IvsVersion; the column names are saved as the FieldName values.
The following columns from AsEnrollmentTransaction are saved in IvsVersionField:
| Field Names | Description |
| PlanGUID, TransactionGUID, ProductGUID |
The values are saved in the TextValue column (FieldTypeCode = 02) |
Product, IvsCodeRuleType = P4
When a parent or a child Product node is checked in, the current state of the data is saved to IvsVersion, IvsVersionHistory and IvsVersionField. A user can right click and checkout the product to modify the Product details. These modifications are applied to the checked out product. Product configuration is inherited by the product's descendant nodes (child product and child plans) only upon check out of each descendant node.
| Important | During the deployment of a release, if deployment detects that a child's parent product does not exist in the target, an error message is displayed, the deployment is stopped and the deployment is rolled back for all non-committed updates. |
IvsVersion
The table saves the following details for a Product:
- ProductGUID is saved as the RuleGUID.
- VersionNumber, RuleTypeCode, ClientNumber, LastModifiedBy and LastModifiedGMT. For descriptions of columns, refer IvsVersion table.
IvsVersionHistory
The table saves VersionGUID, RuleGUID, Environment, Track, ActionTypeCode, LastModifiedBy, and LastModifiedGMT details of a Product. For column descriptions, refer IvsVersionHistory table.
IvsVersionField
In this table, each column from AsProduct is saved as a separate record. The record contains an associated VersionGUID from IvsVersion; the column names are saved as the FieldName values.
The following columns from AsProduct are saved in IvsVersionField:
| Field Names | Description |
| ProductGUID, ProductName, ProductDescription, CompanyGUID |
The values are saved in the TextValue column (FieldTypeCode = 02). |
| EffectiveFrom, EffectiveTo | The values are saved in the TextValue column (FieldTypeCode = 01). The values are saved in the DateValue column. |
| ProductRelationships | The values are saved in the XMLDataValue column (FieldTypeCode = 05). |
ProductRelationships
Data from AsProductRelationship associated to the Product may contain multiple records and are saved in a XML document as follows:
<ProductRelationShips>
<ProductRelationship>
<ProductRelationshipGUID>[guid]</ProductRelationshipGUID>
<ProductGUID>[guid]</ProductGUID>
<AncestorGUID>[guid]</AncestorGUID>
<PathLength>[integer]</PathLength>
</ProductRelationship>
<ProductRelationship>...</ProductRelationship>
</ProductRelationShips>
|
Element and Attribute Description of <ProductRelationships>
| Element | Parent Element | Description | Value |
| <ProductRelationships> | Provides the table name where the records were saved or will be saved. | ||
| <ProductRelationship> | <ProductRelationships> |
Required, Repeatable: Allows the system to record a creation or update action. |
|
|
<ProductRelationshipGUID> |
<ProductRelationship> |
Required: The ID of the Product Relationship record. |
GUID |
| <ProductGUID> | <ProductRelationship> |
Required: The ID of the Product record. |
GUID |
| <AncestorGUID> | <ProductRelationship> |
Required: The ID of the immediate parent Product record. |
GUID |
| <PathLength> | <ProductRelationship> |
Required: Position of the Product record within the ancestral hierarchy where the 0 is the oldest parent in the hierarchy. |
Integer |
Rate Group, IvsCodeRuleType = 11
When a RateGroup in the Palette is checked in, the current state of the RateGroup data and all rates associated to the RateGroup are saved to IvsVersion, IvsVersionHistory and IvsVersionField. When a RateGroup is checked out, the user is prompted to enter the configuration package name to which the modifications should be saved.
| Important | Rates for a RateGroup may contain a huge volume of records, and an appropriate warning message is displayed to the user. Because of its volume, a single XML document may not contain all rates for the Rate Group. Palette generates different XML documents (of 5MB size) for multiple records. |
IvsVersion
The table saves the following details for a RateGroup:
- RateGroupGUID is saved as the RuleGUID.
- VersionNumber, RuleTypeCode, ClientNumber, LastModifiedBy and LastModifiedGMT. For column descriptions, refer IvsVersion table.
IvsVersionHistory
The table saves VersionGUID, RuleGUID, Environment, Track, ActionTypeCode, LastModifiedBy, and LastModifiedGMT details of a RateGroup. For column descriptions, refer IvsVersionHistory table.
IvsVersionField
In this table, each column from AsRates is saved as a separate record. The record contains an associated VersionGUID from IvsVersion; the column names are saved as the FieldName values.
The following columns from AsRates are saved in IvsVersionField:
| Field Names | Description |
| RateGroupGUID, RateDescription, StatusCode, TypeCode, TableFormat, SecondaryIndex, IntegerCriteria |
The values are saved in the TextValue column (FieldTypeCode = 02) |
| ActiveFromDate, ActiveToDate, EffectiveDate, ExpirationDate, | The values are saved in the TextValue column (FieldTypeCode = 01) |
| Criteria1, Criteria2, Criteria3, Criteria4, Criteria5, Criteria6, Criteria7, Criteria8, Criteria9, Criteria10 |
The value in each column is saved in the TextValue column (FieldTypeCode = 02) of separate IvsVersionField records. Note: The number of Rate Criteria system supports by default is 10. User can define more number of Criteria columns as needed. The Rate Group is saved in Version History as per the number of Criteria columns defined. |
| XMLData | The content of this column is saved in the XMLDataValue column (FieldTypeCode = 05) in an IvsVersionField record. |
| Rates |
The content for the Rates column is saved in the XMLDataValue column (FieldTypeCode = 05) in an IvsVersionField record; and the AsRate record data associated to the AsRateGroup is saved in an XML document. Rates for a RateGroup may contain a huge volume of records. Because of its volume, a single XML document may not contain all rates for the Rate Group. Palette generates different XML documents (of 5MB size) for multiple records with the same FieldName until all the rates are recorded. |
The AsRate record data associated to the AsRateGroup is saved in an XML document as follows:
<RateGroup>
<Rates>
<Criteria1>[list]</Criteria1>
<Criteria2>[list]</Criteria2>
<Criteria10>[list]</Criteria10>
<Criteria5>[list]</Criteria5>
<Criteria6>[list]</Criteria6>
<Criteria3>[list]</Criteria3>
<Criteria4>[list]</Criteria4>
<Criteria9>[list]</Criteria9>
<Criteria7>[list]</Criteria7>
<Criteria8>[list]</Criteria8>
<DateCriteria>[list]</DateCriteria>
<IntegerCriteria>[list]</IntegerCriteria>
<RateGUIDs>[list]</RateGUIDs>
</Rates>
</RateGroup
|
Element and Attribute Description of <RateGroup>
| Element | Parent Element | Description | Values |
| <RateGroup> | Opening element for the XML representation of a Rate Group. | ||
| <Rates> | <RateGroup> |
Required: This element contains all the rates for the Rate Group. The rates with criteria are provided in lists; and all lists are combined such that, each iteration of the values are related to the rate. |
|
|
<Criteria1>, <Criteria2>, <Criteria3>, <Criteria4>, <Criteria5>, <Criteria6>, <Criteria7>, <Criteria8>, <Criteria9>, <Criteria10> |
<Rates> |
Optional: All elements are optional. Each element contains a comma delimited list of all criteria values in the Rate Group. The element will not be present in the document if all values are null or empty. Note: For example, the element <Criteria1> contains a comma delimited list of all Criteria1 values in the Rate Group; and <Criteria2> contains a comma delimited list of all Criteria2 values in the Rate Group and so on. |
list |
| <IntegerCriteria> | <Rates> |
Required: The element contains a comma delimited list of all IntegerCriteria values in the Rate Group. |
list |
| <Rate> | <Rates> |
Required: The attribute contains a comma delimited list of all Rate values in the Rate Group. |
list |
| <RateGUIDs> | <Rates> |
Required: The attribute contains a comma delimited list of all RateGUID values in the Rate Group. |
list |
SecurityGroup, IvsCodeRuleType = SG
All the security data tables are grouped in version history because the Palette tightly couples the security tables together. When a SecurityGroup is created or modified under the Application Security node, the current state of the data is saved to IvsVersion, IvsVersionHistory and IvsVersionField. If a specific security group is deleted, it is captured as an action in the configuration package; and all the authorizations associated to that Security Group are deleted.
IvsVersion
The table saves the following details for a Security Group:
- SecurityGroupGUID is saved as the RuleGUID.
- VersionNumber, RuleTypeCode, ClientNumber, LastModifiedBy and LastModifiedGMT. For column descriptions, refer IvsVersion table.
IvsVersionHistory
The table saves the following details:
- VersionGUID, RuleGUID, Environment, Track, ActionTypeCode, LastModifiedBy, and LastModifiedGMT details of a SecurityGroup. For column descriptions, refer IvsVersionHistory table.
IvsVersionField
In this table, each column from from AsSecurityGroup is saved as a separate record. The record contains an associated VersionGUID from IvsVersion; the column names are saved as the FieldName values.
| Field Names | Description |
| SecurityGroupGUID, GroupName |
The values are saved in the TextValue column (FieldTypeCode = 02) |
Auth Company, IvsCodeRuleType = S0
When a Company Security node is checked in, the current state of the data is saved to IvsVersion, IvsVersionHistory and IvsVersionField. If a Company security is deleted, it is captured as an action in the configuration package; and all the Company security details are deleted.
Palette allows a user to revert the current version of Auth Company data to any prior version. As shown below, from the list of primary and subsidiary companies displayed from AsCompany, a user can select the check boxes of AsAuthCompany data for the Security Group to revert to the prior version.
IvsVersion
The table saves the following details for Auth Company:
- A concatenation of SecurityGroupGUID, "_" and SecurityGroupName is saved as the RuleGUID.
- VersionNumber, RuleTypeCode, ClientNumber, LastModifiedBy and LastModifiedGMT. For column descriptions, refer IvsVersion table.
IvsVersionHistory
The table saves the following details:
- A concatenation of SecurityGroupGUID, "_" and SecurityGroupName is saved as the RuleGUID.
- VersionGUID, Environment, Track, ActionTypeCode, LastModifiedBy, and LastModifiedGMT details of an Auth Company. For column descriptions, refer IvsVersionHistory table.
IvsVersionField
In this table, the record is saved with an associated VersionGUID from IvsVersion. The XML document contains all the data as a record in the XMLData field.
| Field Name | Description |
| XMLData |
This is the fieldname of an IVSVersionField record that contains AsAuthCompany data associated to the SecurityGroup. The XML document contains this data, which is saved in the XMLDataValue column (FieldTypeCode = 05). |
The AsAuthCompany data associated to the SecurityGroup is saved in an XML document as follows:
<CompanySecurity RULEGUID="[guid]">
<PrimaryCompany NAME="[company name]" GUID="[guid]" ALLOWED="[true | false]">
<SubsidiaryCompany NAME="company name]" GUID="[guid]" ALLOWED="[true | false]"></SubsidiaryCompany>
<SubsidiaryCompany>...</SubsidiaryCompany>
</PrimaryCompany>
<PrimaryCompany>...</PrimaryCompany>
</CompanySecurity>
|
Element and Attribute Description of <CompanySecurity>
| Element | Parent Element | Attribute | Description | Values |
| CompanySecurity> | Opening element for the AuthCompany's version history record. | |||
| <CompanySecurity> | RULEGUID |
Required: This entity version's RuleGUID (concatenated SecurityGroupGUID_SecurityGroupName). |
GUID | |
| <PrimaryCompany> | <CompanySecurity> |
Required, Repeatable: Opening element for a Primary Company. |
||
| <PrimaryCompany> | NAME |
Required: The name of the company. |
company name | |
| <PrimaryCompany> | GUID |
Required: The unique ID for the company. |
company GUID | |
| <PrimaryCompany> | ALLOWED |
Required: The value of the attribute indicates if this record provides security group access to the company. |
true, false | |
| <SubsidiaryCompany> | <PrimaryCompany> |
Required, Repeatable: Opening element for a Subsidiary Company. |
||
| <SubsidiaryCompany> | NAME |
Required: The name of the company. |
company name | |
| <SubsidiaryCompany> | GUID |
Required: The unique ID for the company. |
company GUID | |
| <SubsidiaryCompany> | ALLOWED |
Required: The value of the attribute indicates if this record provides security group access to the company. |
true, false |
Auth Company Page, IvsCodeRuleType =S1
When a Company Page node is checked in, the current state of the data is saved to IvsVersion, IvsVersionHistory and IvsVersionField. If a SecurityGroup is deleted, it is captured as an action in the configuration package; and all the Auth Company Pages are deleted in that security group.
Company Pages node has the options to Grant Access to All Pages and Remove Access to All Pagesfor specific plans. Version history is captured for all the access changes happening to specific nodes when either of these options is selected by the user; and also all other realized scenario changes are captured in version history.
Collapsible Fields Section
In this section, each page that has resolved a rule, lists all the defined fields regardless of the authorization data in the current and reverted versions. For each field that has an associated security value, the current or reverted version data provides the security value. For fields that have no associated security value, the default security value is displayed.
Collapsible Buttons Section
In this section, each transaction contains a system defined list of buttons that are specific to different pages; and the section lists all the buttons with an associated check box regardless of the data in the current and reverted versions.
Collapsible Masks Section
In this section, each page that has resolved a rule, lists all the defined masks regardless of the authorization data in the current and reverted versions. For each mask that has an associated security value, the current or reverted version data provides the security value. For masks that have no associated security value, the default security value is displayed.
Collapsible Client Type Section
In this section, each page that has resolved a rule, lists all the defined Client Types available to the screen regardless of the authorization data in the current and reverted versions. If a ClientType has an associated check box and the current data or the reverted version data, it indicates that the boxes are checked.
Collapsible Threshold Limit Section
In this section, each page that has resolved a rule, lists all the defined fields regardless of the data in the current and reverted versions. Each field has minimum and maximum limits, and currency code values presented in a grid and the current data or the reverted version data provides values to fill into those grid cells.
IvsVersion
The table saves the following details for a AsAuthCompanyPage:
- A concatenation of AuthPageGUID, "_" and AuthCompanyGUID is saved as the RuleGUID.
- VersionNumber, RuleTypeCode, ClientNumber, LastModifiedBy and LastModifiedGMT. For column descriptions, refer IvsVersion table.
IvsVersionHistory
The table saves the following details:
- A concatenation of AuthPageGUID, "_" and AuthCompanyGUID is saved as the RuleGUID.
- VersionGUID, Environment, Track, ActionTypeCode, LastModifiedBy, and LastModifiedGMT details of AuthCompanyPage. For column descriptions, refer IvsVersionHistory table.
IvsVersionField
In this table, the associated VersionGUID from IvsVersion is saved. All data associated to a single record of the entity is saved to the same XML document.
| Field Names | Description |
| XMLData |
This is the fieldname of an IVSVersionField record that contains the below AsAuthCompanyPage data in an XML document. The values are saved in the XMLDataValue column (FieldTypeCode = 05). The data sections are different for different company pages.
|
AuthCompanyPage data is saved in an XML document as follows:
<CompanyPageSecurity RULEGUID="[guid]">
<CompanyPage NAME="[page name]" GUID="[AuthCompanyGUID]" AUTHCOMPANYPAGEGUID="[AuthCompanyPageGUID]" ALLOWED="[true | false]">
<Buttons>
<Button NAME="[button name]" GUID="[AuthButtonGUID]" AUTHCOMPANYPAGEBUTTONGUID="[guid]" ALLOWED="[true | false]"></Button>
<Button ...></Button>
</Buttons>
<ButtonLimits>
<ButtonLimit FIELDNAME="[field name]" MINIMUM="[number]" MAXIMUM="[number]" CURRENCYCODE="[currency code]" AUTHCOMPANYPAGEBUTTONGUID="[GUID]"></ButtonLimit>
<ButtonLimit ...></ButtonLimit>
</ButtonLimits>
<Fields>
<Field NAME="[field name]" SECURITYLEVELCODE="[code value]"></Field>
<Field ...></Field>
</Fields>
<Masks>
<Mask NAME="[mask name]" SECURITYLEVELCODE="[code value]"></Mask>
<Mask ...></Mask>
</Masks>
<ClientTypes>
<ClientType ClientTypeNamme="[name]" ClientTypeCodeValue="[code value]" ALLOWED="[true | false]"></ClientType>
<ClientType ...></ClientType>
</ClientTypes>
</CompanyPage>
</CompanyPageSecurity>
|
Element and Attribute Description of <CompanyPageSecurity>
| Element | Parent Element | Attribute | Description | Values |
| <CompanyPageSecurity> | Opening element for the page's version history record. | |||
| <CompanyPageSecurity> | RULEGUID |
Required: This entity version's RuleGUID (concatenated AuthPageGUID_AuthCompanyGUID). |
GUID | |
| <CompanyPage> | <CompanyPageSecurity> |
Required: Opening element for the page's version history record. |
||
| <CompanyPage> | NAME |
Required: Name of the page being versioned. |
company page name | |
| <CompanyPage> | GUID |
Required: Identifies the AuthCompany record. |
AuthCompanyGUID | |
| <CompanyPage> | AUTHCOMPANYPAGEGUID |
Optional: Provides the ID of the AuthCompanyPage record. This attribute does not exist when the ALLOWED attribute is false. |
AuthCompanyPageGUID | |
| <CompanyPage> | ALLOWED |
Required: The value of the attribute indicates if this record provides security group access to the page. |
true, false | |
| <Buttons> | <CompanyPage> |
Required: Defines a section that describes user's group access to buttons on the page. |
||
| <Button> | <Buttons> |
Optional, Repeatable: This element identifies the buttons available on the page and defines access for the security group. Note: Few pages do not provide selective access to its buttons or do not have buttons. |
||
| <Button> | NAME |
Required: Name of a button on the page. |
button name | |
| <Button> | GUID |
Required: Identifies the AuthButton record. |
AuthButtonGUID | |
| <Button> | AUTHCOMPANYPAGEBUTTONGUID |
Optional: Provides the ID of the AuthCompanyPageButton record. This attribute does not exist when the ALLOWED attribute is false. |
AuthCompanyPageButtonGUID | |
| <Button> | ALLOWED |
Required: The value of the attribute indicates if this record provides security group access to the button. |
true, false | |
| <ButtonLimits> | <CompanyPage> |
Required: Defines a section that describes the security group's authorization limits on fields as a user clicks a button. |
||
| <ButtonLimit> | <ButtonLimits> |
Optional, Repeatable: This element identifies a field, the group's limits and the button press upon which an authorization limit is placed. |
||
| <ButtonLimit> | FIELDNAME |
Required: This attribute identifies the field by name that receives the authorization limit. |
field name | |
| <ButtonLimit> | MINIMUM |
Required: This attribute defines the floor amount of authorization. |
number | |
| <ButtonLimit> | MAXIMUM |
Required: This attribute defines the ceiling limit of authorization. |
number | |
| <ButtonLimit> | CURRENCYCODE |
Required: This attribute defines the currency expressed by the MINIMUM and MAXIMUM attributes. |
currency code | |
| <ButtonLimit> | AUTHCOMPANYPAGEBUTTONGUID |
Required: This attribute defines the button that when pressed will execute the limit on the field. |
GUID | |
| <Fields> | <CompanyPage> |
Required: Defines a section that describes user's group access to fields on the page. |
||
| <Field> | <Fields> |
Optional, Repeatable: This element identifies the fields available on the page and defines access via their visibility for the security group. Some pages do not have fields to provide selective access. |
||
| <Field> | NAME |
Required: Name of a field on the page. |
field name | |
| <Field> | SECURITYLEVELCODE |
Required: A code value for the level of security provided to the field. |
code value(AsCodeSecurityLevel) | |
| <Masks> | <CompanyPage> |
Required: Defines a section that describes user's group level of visibility on the page. |
||
| <Mask> | <Masks> |
Optional, Repeatable: This element identifies the visibility of the field's data via execution of the field's data mask. Some pages do not have fields or fields do not have defined masks applied. |
||
| <Mask> | NAME |
Required: Name of the mask defined on the page. |
mask name | |
| <Mask> | SECURITYLEVELCODE |
Required: A code value for the level of security provided to the mask. |
code value(AsCodeMaskSecurityLevel) | |
| <ClientTypes> | <CompanyPage> |
Required: Defines a section that describes user's group access to a Client's type on the page. |
||
| <ClientType> | <ClientTypes> |
Optional, Repeatable: This element identifies the Client type |
||
| <ClientType> | ClientTypeName |
Required: The short description from AsCodeClientType for the client type that this element is defining access to. |
field name | |
| <ClientType> | ClientTypeCodeValue |
Required: This is the code value for the client type that this element is defining access to. |
code value(AsCodeClientType) |
|
| <ClientType> | ALLOWED |
Required: The value of the attribute indicates if this record provides security group access to the client type. |
true, false |
Security Auth Company Web Services, IvsCodeRuleType = S2
When a Company's WebService Security node is checked in, the current state of the data is saved to IvsVersion, IvsVersionHistory and IvsVersionField. If a Security Group is deleted, it is captured as an action in the configuration package; and all the Auth Web Services are deleted in that Security Group.
The user can select and revert the current version of Web Services data to any prior version.
IvsVersion
The table saves the following details for Auth Web Services:
- A concatenation of CompanyGUID, "_" and AuthCompanyGUID is saved as the RuleGUID.
- VersionNumber, RuleTypeCode, ClientNumber, LastModifiedBy and LastModifiedGMT. For column descriptions, refer IvsVersion table.
IvsVersionHistory
The table saves the following details:
- A concatenation of CompanyGUID, "_" and AuthCompanyGUID is saved as the RuleGUID.
- VersionGUID, Environment, Track, ActionTypeCode, LastModifiedBy, and LastModifiedGMT details of Auth Web Services. For column descriptions, refer IvsVersionHistory table.
IvsVersionField
All data associated to a single record of the entity (Auth Web Services) is saved to the same XML document.
| Field Name | Description |
| AuthCompanyWebServices |
This is the fieldname of an IVSVersionField record that contains the AsAuthCompanyWebServices associated to a single AuthCompany in an XML document. The values are saved in the XMLDataValue column (FieldTypeCode = 05). The XML document contains the data for all potential web services available to a company. |
AuthCompanyWebServices data is saved in an XML document as follows:
<WebServiceSecurity>
<WebServices RULEGUID="[guid]">
<WebService NAME="[service name]">
<Mathod NAME="[method name]" GUID="[guid]" FILEID="[file id]" ALLOWED="[true | false]"></Mathod>
</WebService>
<WebService>...</WebService>
</WebServices>
</WebServiceSecurity>
|
Element and Attribute Description of <WebServiceSecurity>
| Element | Parent Element | Attribute | Description | Values |
| <WebServiceSecurity> |
Opening element of the version history record for the company's web services security. |
|||
| <WebServices> | <WebServiceSecurity> |
Required: The opening element for a collections of web services. |
||
| <WebServices> | RULEGUID |
Required: This entity version's RuleGUID (concatenated CompanyGUID_AuthCompanyGUID). |
GUID | |
| <WebService> | <WebServices> |
Required, Repeatable: The element to hold a single web service's data. |
||
| <WebService> | NAME |
Required: Provides a name for this specific web service. |
service name | |
| <Method> | <WebService> |
Required: The element to hold a single web service's method data. |
||
| <Method> | NAME |
Required: Identifies the web service's method name. |
method name | |
| <Method> | GUID |
Required: Provides the AuthWebServiceGUID for the specific web service. |
GUID | |
| <Method> | FILEID |
Required: Provides the FileID for the specific web service. |
file ID | |
| <Method> | ALLOWED |
Required: The value of the attribute indicates if this record provides security group access to the method. |
true, false |
Security Auth Main Menu and Client Level Inquiry Screens, IvsCodeRuleType = S3
When a Main Menu Inquiry Security node or a Client Level Inquiry Security node is checked in, the current state of the data is saved to IvsVersion, IvsVersionHistory and IvsVersionField. If a Security Group is deleted, it is captured as an action in the configuration package; and Auth Main Menu and Client Level Inquiry Security details are deleted in that Security Group.
Main Menu and Client Level nodes have the options to Grant Access to All Pages and Remove Access to All Pages. Version history is captured for all the access changes happening to specific nodes when either of these options is selected by the user; and also all other realized scenario changes are captured in version history.
| Note | Version history is captured if the selected option generates a change in child nodes and also increases the version history. |
The user can select and revert the current version of AuthCompanyInquiry data to any prior version.
IvsVersion
The table saves the following details for AuthCompanyInquiry:
- A concatenation of InquiryScreenNameGUID, "_" and SecurityGroupGUID is saved as the RuleGUID.
- VersionNumber, RuleTypeCode, ClientNumber, LastModifiedBy and LastModifiedGMT. For column descriptions, refer IvsVersion table.
IvsVersionHistory
The table saves the following details:
- A concatenation of InquiryScreenNameGUID, "_" and SecurityGroupGUID is saved as the RuleGUID.
- VersionGUID, Environment, Track, ActionTypeCode, LastModifiedBy, and LastModifiedGMT details of AuthCompanyInquiry. For column descriptions, refer IvsVersionHistory table.
IvsVersionField
In this table, the record is saved with an associated VersionGUID from IvsVersion; all data from a single AsAuthCompanyInquiry is saved to the same XML document as described below:
| Field Name | Description |
| AuthCompanyInquiry |
This is the fieldname of an IvsVersionField record that contains the AsAuthCompanyInquiry data for a specific InquiryScreen within the Primary Company. The XML document contains this data from the value saved in the XMLDataValue column (FieldTypeCode = 05). |
AuthCompanyInquiry data is saved in an XML document as follows:
<InquiryPageSecurity RULEGUID="[guid]">
<InquiryPage GUID="[guid]" ALLOWED="[true | false]" AUTHCOMPANYGUID="[guid]" NAME="[page name]" AUTHCOMPANYINQUIRYGUID="[guid]"></InquiryPage> </InquiryPageSecurity> |
Element and Attribute Description of <InquiryPageSecurity>
| Element | Parent Element | Attribute | Description | Values |
| <InquiryPageSecurity> | Opening element of the version history record for the company's inquiry screen security. | |||
| <InquiryPageSecurity> | RULEGUID |
Required: This entity version's RuleGUID (concatenated InquiryScreenNameGUID_SecurityGroupGUID). |
GUID | |
| <InquiryPage> | <InquiryPageSecurity> |
Required: The element contains the InquiryScreen security for the company. |
||
| <InquiryPage> | GUID |
Required: Provides the InquiryScreenGUID for the specific Inquiry Screen. |
GUID | |
| <InquiryPage> | ALLOWED |
Required: The value of the attribute indicates if this record provides security group access to the company's Inquiry Screen. |
true, false | |
| <InquiryPage> | AUTHCOMPANYGUID |
Required: Provides the AuthCompanyGUID associated with this specific Inquiry Screen. |
GUID | |
| <InquiryPage> | NAME |
Required: Provides the name of the Inquiry Screen. |
name | |
| <InquiryPage> | AUTHCOMPANYINQUIRYGUID |
Required: Provides the unique ID for the security record. |
GUID |
Policy Level Inquiry (derived from a plan), IvsCodeRuleType = S3
When a Policy Level Inquiry Security node derived from a Plan is checked in, the current state of the data is saved to IvsVersion, IvsVersionHistory and IvsVersionField. If a Security Group is deleted, it is captured as an action in the configuration package; and Auth Main Menu and Client Level Inquiry Security are deleted in that Security Group.
Specific Plans under the Policy Level Inquiry Security nodes have the options to Grant Access to All Pages, Remove Access to All Pages, and Copy Parent Access. Version history is captured for all the access changes happening to specific nodes when either of these options is selected by the user; and also all other realized scenario changes are captured in version history.
| Note | Version history is captured if the selected option generates a change in child nodes and also increases the version history. |
The user can select and revert the current version of AuthCompanyInquiry data to any prior version.
IvsVersion
The table saves the following details for a AuthCompanyInquiry:
- A concatenation of InquiryScreenNameGUID, "_" and SecurityGroupGUID is saved as the RuleGUID.
- VersionNumber, RuleTypeCode, ClientNumber, LastModifiedBy and LastModifiedGMT. For column descriptions, refer IvsVersion table.
IvsVersionHistory
The table saves the following details:
- A concatenation of InquiryScreenNameGUID, "_" and SecurityGroupGUID is saved as the RuleGUID.
- VersionGUID, Environment, Track, ActionTypeCode, LastModifiedBy, and LastModifiedGMT details of AuthCompanyInquiry. For column descriptions, refer IvsVersionHistory table.
IvsVersionField
In this table,the record is saved with an associated VersionGUID from IvsVersion; All data from a single AsAuthCompanyInquiry is saved to the same XML document as follows.
| Field Name | Description |
| AuthCompanyInquiry |
This is the fieldname of an IvsVersionField record that contains the AsAuthCompanyInquiry data for a specific InquiryScreen within the Primary Company. The XML document contains this data from the value saved in the XMLDataValue column (FieldTypeCode = 05). |
AuthCompanyInquiry data is saved in an XML document as follows:
InquiryPageSecurity RULEGUID="[guid]">
<InquiryPage GUID="[guid]" ALLOWED="[true | false]" AUTHPLANGUID="[guid]" NAME="[page name]" AUTHPLANINQUIRYGUID="[guid]"></InquiryPage>
</InquiryPageSecurity>
|
Element and Attribute Description of <InquiryPageSecurity>
| Element | Parent Element | Attribute | Description | Values |
| <InquiryPageSecurity> | Opening element of the version history record for the plan's inquiry screen security. | |||
| <InquiryPageSecurity> | RULEGUID |
Required: This entity version's RuleGUID (concatenated InquiryScreenNameGUID_SecurityGroupGUID). |
GUID | |
| <InquiryPage> | <InquiryPageSecurity> |
Required: The element to contains the InquiryScreen security for the Plan. |
||
| <InquiryPage> | GUID |
Required: Provides the InquiryScreenGUID for the specific Inquiry Screen. |
GUID | |
| <InquiryPage> | ALLOWED |
Required: The value of the attribute indicates if this record provides security group access to the plan's Inquiry Screen. |
true, false | |
| <InquiryPage> | AUTHPLANGUID |
Required: Provides the AuthPlanGUID associated with this specific Inquiry Screen. |
GUID | |
| <InquiryPage> | NAME |
Required: Provides the name of the Inquiry Screen. |
name | |
| <InquiryPage> | AUTHPLANINQUIRYGUID |
Required: Provides the unique ID for the security record. |
GUID |
Policy Level Inquiry (derived from a product), IvsCodeRuleType = S3
When a Policy Level Inquiry Security node derived from a Product is checked in, the current state of the data is saved to IvsVersion, IvsVersionHistory and IvsVersionField. If a Security Group is deleted, it is captured as an action in the configuration package; and Auth Main Menu and Client Level Inquiry Security are deleted in that Security Group.
Specific Products under the Policy Level Inquiry Security nodes have the options to Grant Access to All Pages and Remove Access to All Pages. Version history is captured for all the access changes happening to specific nodes when either of these options is selected by the user; and also all other realized scenario changes are captured in version history.
The user can select and revert the current version of AuthCompanyInquiry data to any prior version.
IvsVersion
The table saves the following details for a AuthCompanyInquiry:
- A concatenation of InquiryScreenNameGUID, "_" and SecurityGroupGUID is saved as the RuleGUID.
- VersionNumber, RuleTypeCode, ClientNumber, LastModifiedBy and LastModifiedGMT. For column descriptions, refer IvsVersion table.
IvsVersionHistory
The table saves the following details:
- A concatenation of InquiryScreenNameGUID, "_" and SecurityGroupGUID is saved as the RuleGUID.
- VersionGUID, Environment, Track, ActionTypeCode, LastModifiedBy, and LastModifiedGMT details of AuthCompanyInquiry. For column descriptions, refer IvsVersionHistory table.
IvsVersionField
In this table,the record is saved with an associated VersionGUID from IvsVersion; All data from a single AsAuthCompanyInquiry is saved to the same XML document as follows.
| Field Name | Description |
| AuthCompanyInquiry |
This is the fieldname of an IvsVersionField record that contains the AsAuthCompanyInquiry data for a specific InquiryScreen within the Primary Company. The XML document contains this data from the value saved in the XMLDataValue column (FieldTypeCode = 05). |
AuthCompanyInquiry data is saved in an XML document as follows:
InquiryPageSecurity RULEGUID="[guid]">
<InquiryPage GUID="[guid]" ALLOWED="[true | false]" AUTHPRODUCTGUID="[guid]" NAME="[page name]" AUTHPRODUCTINQUIRYGUID="[guid]"></InquiryPage>
</InquiryPageSecurity>
|
Element and Attribute Description of <InquiryPageSecurity>
| Element | Parent Element | Attribute | Description | Values |
| <InquiryPageSecurity> | Opening element of the version history record for the product's inquiry screen security. | |||
| <InquiryPageSecurity> | RULEGUID |
Required: This entity version's RuleGUID (concatenated InquiryScreenNameGUID_SecurityGroupGUID). |
GUID | |
| <InquiryPage> | <InquiryPageSecurity> |
Required: The element to hold the InquiryScreen security for the Product. |
||
| <InquiryPage> | GUID |
Required: Provides the InquiryScreenGUID for the specific Inquiry Screen. |
GUID | |
| <InquiryPage> | ALLOWED |
Required: The value of the attribute indicates if this record provides security group access to the product's Inquiry Screen. |
true, false | |
| <InquiryPage> | AUTHPRODUCTGUID |
Required: Provides the AuthProductGUID associated with this specific Inquiry Screen. |
GUID | |
| <InquiryPage> | NAME |
Required: Provides the name of the Inquiry Screen. |
name | |
| <InquiryPage> | AUTHPRODUCTINQUIRYGUID |
Required: Provides the unique ID for the security record. |
GUID |
Security Auth Plan, IvsCodeRuleType = S4
When a specific Plan under Plan Security is checked in, the current state of the data is saved to IvsVersion, IvsVersionHistory and IvsVersionField. If a Security Group is deleted, it is captured as an action in the configuration package; and all the Auth Plan Security details are deleted in that Security Group.
Specific Plans under the Plan Security have the options to Grant Access to All Pages, Remove Access to All Pages, and Copy Parent Access. Version history is captured for all the access changes happening to specific nodes when either of these options is selected by the user; and also all other realized scenario changes are captured in version history.
IvsVersion
The table saves the following details for a AuthPlan:
- A concatenation of PlanGUID, "_" and AuthCompanyGUID is saved as the RuleGUID.
- VersionNumber, RuleTypeCode, ClientNumber, LastModifiedBy and LastModifiedGMT. For column descriptions, refer IvsVersion table.
IvsVersionHistory
The table saves the following details:
- A concatenation of PlanGUID, "_" and AuthCompanyGUID is saved as the RuleGUID.
- VersionGUID, Environment, Track, ActionTypeCode, LastModifiedBy, and LastModifiedGMT details of AuthPlan. For column descriptions, refer IvsVersionHistory table.
IvsVersionField
In this table,the record is saved with an associated VersionGUID from IvsVersion; All data from a single AsAuthPlan is saved to the same XML document as follows.
| Field Name | Description |
| AuthPlan |
This is the fieldname of an IvsVersionField record that contains the AsAuthPlan data for a specific Plan. The XML document contains this data from the value saved in the XMLDataValue column (FieldTypeCode = 05). |
AuthPlan data is saved in an XML document as follows:
<PlanSecurity RULEGUID="[guid]">
<Plan NAME="[plan name]" GUID="[guid]" ALLOWED="[true | false]" AUTHPLANGUID="[guid]"></Plan>
</PlanSecurity>
|
Element and Attribute Description of <PlanSecurity>
| Element | Parent Element | Attribute | Description | Values |
| <PlanSecurity> | Opening element of the version history record for the plan's security. | |||
| <PlanSecurity> | RULEGUID |
Required: This entity version's RuleGUID (concatenated PlanGUID_AuthCompanyGUID). |
GUID | |
| <Plan> | <PlanSecurity> |
Required: The element to hold the Plan's security. |
||
| <Plan> | NAME |
Required: Provides the Plan's name. |
plan name | |
| <Plan> | GUID |
Required, Repeatable: Provides the PlanGUID. |
GUID | |
| <Plan> | ALLOWED |
Required: The value of the attribute indicates if this record provides security group access to the plan. |
true, false | |
| <Plan> | AUTHPLANGUID |
Required: Provides the unique ID for the security record. |
GUID |
Security Auth Product, IvsCodeRuleType =S5
When a Product node listed under another Product (or) under a Company under Plan Security is checked in, the current state of the data is saved to IvsVersion, IvsVersionHistory and IvsVersionField. If a Security Group is deleted, it is captured as an action in the configuration package; and all the Auth Product Security details are deleted in that Security Group.
Specific Products under the Plan Security nodes have the options to Grant Access to All Pages and Remove Access to All Pages. Version history is captured for all the access changes happening to specific nodes when either of these options is selected by the user; and also all other realized scenario changes are captured in version history.
IvsVersion
The table saves the following details for a AuthProduct:
- A concatenation of ProductGUID, "_" and AuthCompanyGUID is saved as the RuleGUID.
- VersionNumber, RuleTypeCode, ClientNumber, LastModifiedBy and LastModifiedGMT. For column descriptions, refer IvsVersion table.
IvsVersionHistory
The table saves the following details:
- A concatenation of ProductGUID, "_" and AuthCompanyGUID is saved as the RuleGUID.
- VersionGUID, Environment, Track, ActionTypeCode, LastModifiedBy, and LastModifiedGMT details of AuthProduct. For column descriptions, refer IvsVersionHistory table.
IvsVersionField
In this table,the record is saved with an associated VersionGUID from IvsVersion; all data from a single AsAuthProduct for a specific plan is saved to the same XML document as follows.
| Field Name | Description |
| AuthProduct |
This is the fieldname of an IvsVersionField record that contains the AsAuthProduct data for a specific Plan. The XML document contains this data from the value saved in the XMLDataValue column (FieldTypeCode = 05). |
AuthProduct data is saved in an XML document as follows:
<ProductSecurity RULEGUID="[guid]">
<Product NAME="[product name]" GUID="[guid]" ALLOWED="[true | false]" AUTHPRODUCTGUID="[guid]"></Product>
</ProductSecurity>
|
Element and Attribute Description of <ProductSecurity>
| Element | Parent Element | Attribute | Description | Values |
| <ProductSecurity> | Opening element of the version history record for the product's security. | |||
| <ProductSecurity> | RULEGUID |
Required: This entity version's RuleGUID (concatenated ProductGUID_AuthCompanyGUID). |
GUID | |
| <Product> | <ProductSecurity> |
Required: The element contains the Product's security details. |
||
| <Product> | NAME |
Required: Provides the Product's name. |
product name | |
| <Product> | GUID |
Required, Repeatable: Provides the ProductGUID. |
GUID | |
| <Product> | ALLOWED |
Required: The value of the attribute indicates if this record provides security group access to the product. |
true, false | |
| <Product> | AUTHPRODUCTGUID |
Required: Provides a unique ID for the security record. |
GUID |
Security Auth Plan Page (derived from a plan), IvsCodeRuleType =S6
When a Plan Pages node listed under a Security Group->Plan->Plan Securty is checked in, the current state of the data is saved to IvsVersion, IvsVersionHistory and IvsVersionField. If a Security Group is deleted, it is captured as an action in the configuration package; and all the Auth Plan Page Security details are deleted in that Security Group.
Specific Plans under the Plan Security nodes have the options to Grant Access to All Pages, Remove Access to All Pages, and Copy Parent Access. Version history is captured for all the access changes happening to specific nodes when either of these options is selected by the user; and also all other realized scenario changes are captured in version history.
Collapsible Buttons Section
In this section, each transaction contains a system defined list of buttons that are specific to different pages; and the section lists all the buttons with an associated check box regardless of the data in the current and reverted versions.
Collapsible Fields Section
In this section, each transaction configuration is resolved with a defined field; the section lists all the defined fields regardless of the authorization data in the current and reverted versions. For each transaction, that has an associated security value, the current or reverted version data provides the security value. For transactions, that have no associated security value, the default security value is displayed.
Collapsible Masks Section
In this section, each transaction configuration that is resolved may contain masks for any fields; and the section lists all the defined masks regardless of the authorization data in the current and reverted versions. For each transaction, that has an associated security value, the current or reverted version data provides the security value. For transactions, that have no associated security value, the default security value is displayed.
IvsVersion
The table saves the following details for an Auth Plan Page:
- A concatenation of AuthPageGUID, "_" and AuthPlanGUID is saved as the RuleGUID.
- VersionNumber, RuleTypeCode, ClientNumber, LastModifiedBy and LastModifiedGMT. For column descriptions, refer IvsVersion table.
IvsVersionHistory
The table saves the following details:
- A concatenation of AuthPageGUID, "_" and AuthPlanGUID is saved as the RuleGUID.
- VersionGUID, Environment, Track, ActionTypeCode, LastModifiedBy, and LastModifiedGMT details of Auth Plan Page. For column descriptions, refer IvsVersionHistory table.
IvsVersionField
In this table, the record is saved with an associated VersionGUID from IvsVersion; All data associated to a single record of the entity (Auth Plan Page) is saved to the same XML document as follows.
| Field Name | Description |
| XMLData |
This is the fieldname of an IvsVersionField record that contains the below AsAuthPlanPage data. The data sections are different for different Plan pages.
The XML document contains this data from the value saved in the XMLDataValue column (FieldTypeCode = 05). |
Auth Plan Page data is saved in an XML document as follows:
<PlanPageSecurity RULEGUID="[guid]">
<PlanPage NAME="[page name]" GUID="[AuthPlanGUID]" AUTHPLANPAGEGUID="[AuthPlanPageGUID]" ALLOWED="[true | false]">
<Buttons>
<Button NAME="[button name]" GUID="[AuthButtonGUID]" AUTHPLANPAGEBUTTONGUID="[guid]" ALLOWED="[true | false]"></Button>
<Button ...></Button>
</Buttons>
<Fields>
<Field NAME="[field name]" SECURITYLEVELCODE="[code value]"></Field>
<Field ...></Field>
</Fields>
<Masks>
<Mask NAME="[mask name]" SECURITYLEVELCODE="[code value]"></Mask>
<Mask ...></Mask>
</Masks>
</PlanPage>
</PlanPageSecurity>
|
Element and Attribute Description of <PlanPageSecurity>
| Element | Parent Element | Attribute | Description | Values |
| <PlanPageSecurity> | Opening element for the Plan page's version history record. | |||
| <PlanPageSecurity> | RULEGUID |
Required: This entity version's RuleGUID (concatenated AuthPageGUID_AuthPlanGUID). |
GUID | |
| <PlanPage> | <PlanPageSecurity> |
Required: Opening element for the page's version history record. |
||
| <PlanPage> | NAME |
Required: Name of the page being versioned. |
page name | |
| <PlanPage> | GUID |
Required: Identifies the AuthPlan record. |
AuthPlanGUID | |
| <PlanPage> | AUTHPLANPAGEGUID |
Optional: Provides the ID of the AuthPlanPage record. Note: This attribute does not exist when the ALLOWED attribute is false. |
AuthPlanPageGUID | |
| <PlanPage> | ALLOWED |
Required: The value of the attribute indicates if this record provides security group access to the page. |
true, false | |
| <Buttons> | <PlanPage> |
Required: Defines a section that describes user's group access to buttons on the page. |
||
| <Button> | <Buttons> |
Optional, Repeatable: This element identifies the buttons available on the page and defines access for the security group. Note: Few pages do not provide selective access to its buttons or do not have buttons. |
||
| <Button> | NAME |
Required: Name of a button on the page. |
button name | |
| <Button> | GUID |
Required: Identifies the AuthButton record. |
AuthButtonGUID | |
| <Button> | AUTHPLANPAGEBUTTONGUID |
Optional: Provides the ID of the AuthPlanPageButton record. Note: This attribute does not exist when the ALLOWED attribute is false. |
AuthPlanPageButtonGUID | |
| <Button> | ALLOWED |
Required: The value of the attribute indicates if this record provides security group access to the button. |
true, false | |
| <Fields> | <PlanPage> |
Required: Defines a section that describes user's group access to fields on the page. |
||
| <Field> | <Fields> |
Optional, Repeatable: This element identifies the fields available on the page and defines access through their visibility for the security group. Note: Few pages do not have fields to provide selective access. |
||
| <Field> | NAME |
Required: Name of a field on the page. |
field name | |
| <Field> | SECURITYLEVELCODE |
Required: A code value for the level of security provided to the field. |
code value(AsCodeSecurityLevel) | |
| <Masks> | <PlanPage> |
Required: Defines a section that describes user's group level of visibility on the page. |
||
| <Mask> | <Masks> |
Optional, Repeatable: This element identifies the visibility of the field's data through execution of the field's data mask. Note: Few pages do not have fields or fields do not have defined masks applied. |
||
| <Mask> | NAME |
Required: Name of the mask defined on the page. |
mask name | |
| <Mask> | SECURITYLEVELCODE |
Required: A code value for the level of security provided to the mask. |
code value(AsCodeMaskSecurityLevel) |
Security Auth Plan Page (derived from a product), IvsCodeRuleType =S6
When a Plan Pages node listed under aSecurity Group->Product->Plan Securty is checked in, the current state of the data is saved to IvsVersion, IvsVersionHistory and IvsVersionField. If a Security Group is deleted, it is captured as an action in the configuration package; and all the Auth Plan Page Security details are deleted in that Security Group.
Specific Products under the Plan Security nodes have the options to Grant Access to All Pages and Remove Access to All Pages. Version history is captured for all the access changes happening to specific nodes when either of these options is selected by the user; and also all other realized scenario changes are captured in version history.
Collapsible Buttons Section
In this section, each transaction contains a system defined list of buttons that are specific to different pages; and the section lists all the buttons with an associated check box regardless of the data in the current and reverted versions.
Collapsible Fields Section
In this section, each transaction configuration is resolved with a defined field; the section lists all the defined fields regardless of the authorization data in the current and reverted versions. For each transaction, that has an associated security value, the current or reverted version data provides the security value. For transactions, that have no associated security value, the default security value is displayed.
Collapsible Masks Section
In this section, each transaction configuration that is resolved may contain masks for any fields; and the section lists all the defined masks regardless of the authorization data in the current and reverted versions. For each transaction, that has an associated security value, the current or reverted version data provides the security value. For transactions, that have no associated security value, the default security value is displayed.
IvsVersion
The table saves the following details for an Auth Product Page:
- A concatenation of AuthPageGUID, "_" and AuthProductGUID is saved as the RuleGUID.
- VersionNumber, RuleTypeCode, ClientNumber, LastModifiedBy and LastModifiedGMT. For column descriptions, refer IvsVersion table.
IvsVersionHistory
The table saves the following details:
- A concatenation of AuthPageGUID, "_" and AuthProductGUID is saved as the RuleGUID.
- VersionGUID, Environment, Track, ActionTypeCode, LastModifiedBy, and LastModifiedGMT details of Auth Product Page. For column descriptions, refer IvsVersionHistory table.
IvsVersionField
In this table, the record is saved with an associated VersionGUID from IvsVersion; All data associated to a single record of the entity (Auth Product Page) is saved to the same XML document as follows.
| Field Name | Description |
| XMLData |
This is the fieldname of an IvsVersionField record that contains the below AsAuthProductPage data. The data sections are different for different Plan pages.
The XML document contains this data from the value saved in the XMLDataValue column (FieldTypeCode = 05). |
Auth Plan Page data is saved in an XML document as follows:
<ProductPageSecurity RULEGUID="[guid]">
<ProductPage NAME="[page name]" GUID="[AuthProductGUID]" AUTHPRODUCTPAGEGUID="[AuthProductPageGUID]" ALLOWED="[true | false]">
<Buttons>
<Button NAME="[button name]" GUID="[AuthButtonGUID]" AUTHPRODUCTPAGEBUTTONGUID="[guid]" ALLOWED="[true | false]"></Button>
<Button ...></Button>
</Buttons>
<Fields>
<Field NAME="[field name]" SECURITYLEVELCODE="[code value]"></Field>
<Field ...></Field>
</Fields>
<Masks>
<Mask NAME="[mask name]" SECURITYLEVELCODE="[code value]"></Mask>
<Mask ...></Mask>
</Masks>
</ProductPage>
</ProductPageSecurity>
|
Element and Attribute Description of <ProductPageSecurity>
| Element | Parent Element | Attribute | Description | Value |
| <ProductPageSecurity> | Opening element for the page's version history record. | |||
| <ProductPageSecurity> | RULEGUID |
Required: This entity version's RuleGUID (concatenated AuthPageGUID_AuthProductGUID). |
GUID | |
| <ProductPage> | <ProductPageSecurity> |
Required: Opening element for the page's version history record. |
||
| <ProductPage> | NAME |
Required: Name of the page being versioned. |
page name | |
| <ProductPage> | GUID |
Required: Identifies the AuthProduct record. |
AuthProductGUID | |
| <ProductPage> | AUTHPRODUCTPAGEGUID |
Optional: Provides the id of the AuthProductPage record. This attribute does not exist when the ALLOWED attribute is false. |
AuthProductPageGUID | |
| <ProductPage> | ALLOWED |
Required: The value of the attribute indicates if this record provides security group access to the page. |
true, false | |
| <Buttons> | <ProductPage> |
Required: Defines a section that describes user's group access to buttons on the page. |
||
| <Button> | <Buttons> |
Optional, Repeatable: This element identifies the buttons available on the page and defines access for the security group. Some pages do not provide selective access to its buttons or do not have buttons. |
||
| <Button> | NAME |
Required: Name of a button on the page. |
button name | |
| <Button> | GUID |
Required: Identifies the AuthButton record. |
AuthButtonGUID | |
| <Button> | AUTHPRODUCTPAGEBUTTONGUID |
Optional: Provides the id of the AuthProductPageButton record. This attribute does not exist when the ALLOWED attribute is false. |
AuthProductPageButtonGUID | |
| <Button> | ALLOWED |
Required: The value of the attribute indicates if this record provides security group access to the button. |
true, false | |
| <Fields> | <ProductPage> |
Required: Defines a section that describes user's group access to fields on the page. |
||
| <Field> | <Fields> |
Optional, Repeatable: This element identifies the fields available on the page and defines access via their visibility for the security group. Some pages do not have fields to provide selective access. |
||
| <Field> | NAME |
Required: Name of a field on the page. |
field name | |
| <Field> | SECURITYLEVELCODE |
Required: A code value for the level of security provided to the field. |
code value(AsCodeSecurityLevel) | |
| <Masks> | <ProductPage> |
Required: Defines a section that describes user's group level of visibility on the page. |
||
| <Mask> | <Masks> |
Optional, Repeatable: This element identifies the visibility of the field's data via execution of the field's data mask. Some pages do not have fields or fields do not have defined masks applied. |
||
| <Mask> | NAME |
Required: Name of the mask defined on the page. |
mask name | |
| <Mask> | SECURITYLEVELCODE |
Required: A code value for the level of security provided to the mask. |
code value(AsCodeMaskSecurityLevel) |
Security Auth Transaction (derived from a Plan), IvsCodeRuleType = S7
When a Transaction Security node listed under a Plan is checked in, the current state of the data is saved to IvsVersion, IvsVersionHistory and IvsVersionField. If a Security Group is deleted, it is captured as an action in the configuration package; and the specific Transaction access details are deleted in that Security Group.
Specific Plans under the Transaction Security nodes have the options to Grant Access to All Pages , Remove Access to All Pages, and Copy Parent Access. Version history is captured for all the access changes happening to specific nodes when either of these options is selected by the user; and also all other realized scenario changes are captured in version history.
The user can select and revert the current version of Auth Transaction data to any prior version.
Collapsible Buttons Section
In this section, each transaction contains a system defined list of buttons that are specific to different pages; and the section lists all the buttons with an associated check box regardless of the data in the current and reverted versions.
Collapsible Fields Section
In this section, each transaction configuration is resolved with a defined field; the section lists all the defined fields regardless of the authorization data in the current and reverted versions. For each transaction, that has an associated security value, the current or reverted version data provides the security value. For transactions, that have no associated security value, the default security value is displayed.
Collapsible Masks Section
In this section, each transaction configuration that is resolved may contain masks for any fields; and the section lists all the defined masks regardless of the authorization data in the current and reverted versions. For each transaction, that has an associated security value, the current or reverted version data provides the security value. For transactions, that have no associated security value, the default security value is displayed.
Collapsible Overridable Errors
In this section, each transaction configuration that includes a ValidateExpressions rule may contain overridable errors; and the section lists the error numbers associated to these errors regardless of the data in the current and reverted versions. For each transaction, that has an associated security value, the current or reverted version data provides the security value. For transactions, that have no associated security value, the default security value is displayed.
IvsVersion
The table saves the following details for an Auth Transaction:
- A concatenation of AuthPageGUID, "_" and AuthPlanGUID is saved as the RuleGUID.
- VersionNumber, RuleTypeCode, ClientNumber, LastModifiedBy and LastModifiedGMT. For column descriptions, refer IvsVersion table.
IvsVersionHistory
The table saves the following details:
- A concatenation of TransactionGUID, "_" and AuthPlanGUID is saved as the RuleGUID.
- VersionGUID, Environment, Track, ActionTypeCode, LastModifiedBy, and LastModifiedGMT details of Auth Transaction. For column descriptions, refer IvsVersionHistory table.
IvsVersionField
In this table, the record is saved with an associated VersionGUID from IvsVersion; All data associated to a single record of the entity (Auth Transaction) is saved to the same XML document as follows.
| Field Name | Description |
| XMLData |
This is the fieldname of an IvsVersionField record that contains the below AsAuthTransaction data. The data sections are different for different Plan pages.
The XML document contains this data from the value saved in the XMLDataValue column (FieldTypeCode = 05). |
Auth Transaction data is saved in an XML document as follows:
<TransactionSecurity RULEGUID="[guid]">
<Transaction NAME="[transaction name]" GUID="[TransactionGUID]" AUTHPLANGUID="[AuthPlanGUID]" AUTHTRANSACTIONGUID="[AuthTransactionGUID]" ALLOWED="[true | false]">
<Buttons>
<Button NAME="[button name]" GUID="[AuthButtonGUID]" AUTHTRANSACTIONBUTTONGUID="[guid]" ALLOWED="[true | false]"></Button>
<Button ...></Button>
</Buttons>
<Fields>
<Field NAME="[field name]" SECURITYLEVELCODE="[code value]"></Field>
<Field ...></Field>
</Fields>
<Masks>
<Mask NAME="[mask name]" SECURITYLEVELCODE="[code value]"></Mask>
<Mask ...></Mask>
</Masks>
<OverrideableErrors>
<OverrideableError ERRORNUMBER="[error number]" SECURITYLEVELCODE="[code value]"></OverrideableError>
<OverrideableError ...></OverrideableError>
</OverrideableErrors>
</Transaction>
</TransactionSecurity>
|
Element and Attribute Description of <TransactionSecurity>
| Element | Parent Element | Attribute | Description | Values |
| <TransactionSecurity> | Opening element for the transaction's version history record. | |||
| <TransactionSecurity> | RULEGUID |
Required: This entity version's RuleGUID (concatenated TransactionGUID_AuthPlanGUID). |
GUID | |
| <Transaction> | <TransactionSecurity> |
Required: Opening element for the transaction's version history record. |
||
| <Transaction> | NAME |
Required: Name of the transaction being versioned. |
transaction name | |
| <Transaction> | GUID |
Required: Identifies the Transaction record. |
TransactionGUID | |
| <Transaction> | AUTHPLANGUID |
Required: Identifies the AuthPlan record. |
AuthPlanGUID | |
| <Transaction> | AUTHTRANSACTIONGUID |
Optional: Provides the ID of the AuthTransaction record. Note: This attribute does not exist when the ALLOWED attribute is false. |
AuthTransactionGUID | |
| <Transaction> | ALLOWED |
Required: The value of the attribute indicates if this record provides security group access to the transaction. |
true, false | |
| <Buttons> | <Transaction> |
Required: Defines a section that describes user's group access to buttons n the transaction. |
||
| <Button> | <Buttons> |
Optional, Repeatable: This element identifies the buttons available in the transaction and defines access for the security group. |
||
| <Button> | NAME |
Required: Name of a button in the transaction. |
button name | |
| <Button> | GUID |
Required: Identifies the AuthButton record. |
AuthButtonGUID | |
| <Button> | AUTHTRANSACTIONBUTTONGUID |
Optional: Provides the ID of the AuthTransactionButton record. Note: This attribute does not exist when the ALLOWED attribute is false. |
AuthTransactionButtonGUID | |
| <Button> | ALLOWED |
Required: The value of the attribute indicates if this record provides security group access to the button. |
true, false | |
| <Fields> | <Transaction> |
Required: Defines a section that describes user's group access to fields in the transaction. |
||
| <Field> | <Fields> |
Optional, Repeatable: This element identifies the fields available in the transaction and defines access via their visibility for the security group. |
||
| <Field> | NAME |
Required: Name of a field in the transaction. |
field name | |
| <Field> | SECURITYLEVELCODE |
Required: A code value for the level of security provided to the field. |
code value(AsCodeSecurityLevel) | |
| <Masks> | <Transaction> |
Required: Defines a section that describes user's group level of visibility in the transaction. |
||
| <Mask> | <Masks> |
Optional, Repeatable: This element identifies the visibility of the field's data via execution of the field's data mask. |
||
| <Mask> | NAME |
Required: Name of the mask defined in the transaction. |
mask name | |
| <Mask> | SECURITYLEVELCODE |
Required: A code value for the level of security provided to the mask. |
code value(AsCodeMaskSecurityLevel) | |
| <OverrideableErrors> | <Transaction> |
Required: Defines a section that describes user's authority level in regards to overriding errors. |
||
| <OverrideableError> | <OverrideableErrors> |
Optional, Repeatable: This element identifies the visibility of the field's data via execution of the field's data mask. |
||
| <OverrideableError> | ERRORNUMBER |
Required: This identifies the error number defined in the transaction's ValidateExpressions business rule. |
error number | |
| <OverrideableError> | SECURITYLEVELCODE |
Required: A code value for the level of security provided to the mask. |
code value(AsCodeMaskSecurityLevel) |
Transaction Security (derived from a Product), IvsCodeRuleType = S7
When a Transaction Security node listed under a Product is checked in, the current state of the data is saved to IvsVersion, IvsVersionHistory and IvsVersionField. If a Security Group is deleted, it is captured as an action in the configuration package; and the specific Transaction access details are deleted in that Security Group.
Specific Products under the Transaction Security nodes have the options to Grant Access to All Pages and Remove Access to All Pages. Version history is captured for all the access changes happening to specific nodes when either of these options is selected by the user; and also all other realized scenario changes are captured in version history.
The user can select and revert the current version of Auth Product Transaction data to any prior version.
Collapsible Buttons Section
In this section, each transaction contains a system defined list of buttons that are specific to different pages; and the section lists all the buttons with an associated check box regardless of the data in the current and reverted versions.
Collapsible Fields Section
In this section, each transaction configuration is resolved with a defined field; the section lists all the defined fields regardless of the authorization data in the current and reverted versions. For each transaction, that has an associated security value, the current or reverted version data provides the security value. For transactions, that have no associated security value, the default security value is displayed.
Collapsible Masks Section
In this section, each transaction configuration that is resolved may contain masks for any fields; and the section lists all the defined masks regardless of the authorization data in the current and reverted versions. For each transaction, that has an associated security value, the current or reverted version data provides the security value. For transactions, that have no associated security value, the default security value is displayed.
Collapsible Overridable Errors
In this section, each transaction configuration that includes a ValidateExpressions rule may contain overridable errors; and the section lists the error numbers associated to these errors regardless of the data in the current and reverted versions. For each transaction, that has an associated security value, the current or reverted version data provides the security value. For transactions, that have no associated security value, the default security value is displayed.
IvsVersion
The table saves the following details for an Auth Product Transaction:
- A concatenation of AuthPageGUID, "_" and AuthProductGUID is saved as the RuleGUID.
- VersionNumber, RuleTypeCode, ClientNumber, LastModifiedBy and LastModifiedGMT. For column descriptions, refer IvsVersion table.
IvsVersionHistory
The table saves the following details:
- A concatenation of TransactionGUID, "_" and AuthProductGUID is saved as the RuleGUID.
- VersionGUID, Environment, Track, ActionTypeCode, LastModifiedBy, and LastModifiedGMT details of Auth Product Transaction. For column descriptions, refer IvsVersionHistory table.
IvsVersionField
In this table, the record is saved with an associated VersionGUID from IvsVersion; all data associated to a single record of the entity (Auth Product Transaction) is saved to the same XML document as follows.
| Field Name | Description |
| XMLData |
This is the fieldname of an IvsVersionField record that contains the below AsAuthProductTransaction data. The data sections are different for different Plan pages.
The XML document contains this data from the value saved in the XMLDataValue column (FieldTypeCode = 05). |
Auth Product Transaction data is saved in an XML document as follows:
<TransactionSecurity RULEGUID="[guid]">
<Transaction NAME="[transaction name]" GUID="[TransactionGUID]" AUTHPRODUCTGUID="[AuthProductGUID]" AUTHPRODUCTTRANSACTIONGUID="[AuthProductTransactionGUID]" ALLOWED="[true | false]">
<Buttons>
<Button NAME="[button name]" GUID="[AuthButtonGUID]" AUTHPRODUCTTRANSACTIONBUTTONGUID="[guid]" ALLOWED="[true | false]"></Button>
<Button ...></Button>
</Buttons>
<Fields>
<Field NAME="[field name]" SECURITYLEVELCODE="[code value]"></Field>
<Field ...></Field>
</Fields>
<Masks>
<Mask NAME="[mask name]" SECURITYLEVELCODE="[code value]"></Mask>
<Mask ...></Mask>
</Masks>
<OverrideableErrors>
<OverrideableError ERRORNUMBER="[error number]" SECURITYLEVELCODE="[code value]"></OverrideableError>
<OverrideableError ...></OverrideableError>
</OverrideableErrors>
</Transaction>
</TransactionSecurity>
|
Element and Attribute Description of <TransactionSecurity>
| Element | Parent Element | Attribute | Description | Values |
| <TransactionSecurity> |
|
|
Opening element for the transaction's version history record. |
|
|
|
<TransactionSecurity> | RULEGUID |
Required: This entity version's RuleGUID (concatenated TransactionGUID_AuthProductGUID). |
GUID |
| <Transaction> | <TransactionSecurity> |
|
Required: Opening element for the transaction's version history record. |
|
|
|
<Transaction> | NAME |
Required: Name of the transaction being versioned. |
transaction name |
|
|
<Transaction> | GUID |
Required: Identifies the Transaction record. |
TransactionGUID |
|
|
<Transaction> | AUTHPRODUCTGUID |
Required: Identifies the AuthProduct record. |
AuthProductGUID |
|
|
<Transaction> | AUTHPRODUCTTRANSACTIONGUID |
Optional: Provides the ID of the AuthProductTransaction record. Note: This attribute does not exist when the ALLOWED attribute is false. |
AuthProductTransactionGUID |
|
|
<Transaction> | ALLOWED |
Required: The value of the attribute indicates if this record provides security group access to the transaction. |
true, false |
| <Buttons> | <Transaction> |
|
Required: Defines a section that describes user's group access to buttons n the transaction. |
|
| <Button> | <Buttons> |
|
Optional, Repeatable: This element identifies the buttons available in the transaction and defines access for the security group. |
|
|
|
<Button> | NAME |
Required: Name of a button in the transaction. |
button name |
|
|
<Button> | GUID |
Required: Identifies the AuthButton record. |
AuthButtonGUID |
|
|
<Button> | AUTHPRODUCTTRANSACTIONBUTTONGUID |
Optional: Provides the ID of the AuthTransactionProductButton record. Note: This attribute does not exist when the ALLOWED attribute is false. |
AuthProductTransactionButtonGUID |
|
|
<Button> | ALLOWED |
Required: The value of the attribute indicates if this record provides security group access to the button. |
true, false |
| <Fields> | <Transaction> |
|
Required: Defines a section that describes user's group access to fields in the transaction. |
|
| <Field> | <Fields> |
|
Optional, Repeatable: This element identifies the fields available in the transaction and defines access via their visibility for the security group. |
|
|
|
<Field> | NAME |
Required: Name of a field in the transaction. |
field name |
|
|
<Field> | SECURITYLEVELCODE |
Required: A code value for the level of security provided to the field. |
code value (AsCodeSecurityLevel) |
| <Masks> | <Transaction> |
|
Required: Defines a section that describes user's group level of visibility in the transaction. |
|
| <Mask> | <Masks> |
|
Optional, Repeatable: This element identifies the visibility of the field's data via execution of the field's data mask. |
|
|
|
<Mask> | NAME |
Required: Name of the mask defined in the transaction. |
mask name |
|
|
<Mask> | SECURITYLEVELCODE |
Required: A code value for the level of security provided to the mask. |
code value (AsCodeMaskSecurityLevel) |
| <OverrideableErrors> | <Transaction> |
|
Required: Defines a section that describes user's authority level in regards to overriding errors. |
|
| <OverrideableError> | <OverrideableErrors> |
|
Optional, Repeatable: This element identifies the visibility of the field's data via execution of the field's data mask. |
|
|
|
<OverrideableError> | ERRORNUMBER |
Required: This identifies the error number defined in the transaction's ValidateExpressions business rule. |
error number |
|
|
<OverrideableError> | SECURITYLEVELCODE |
Required: A code value for the level of security provided to the mask. |
code value |
System Date, IvsCodeRuleType =44
A user can access the System Date editor from Admin Explorer>>Administration node>>System Date
| Important | The System Date node represents all data from AsSystemDate and AsSystemDateField tables. |
The System Date node includes each calendar year as a node in descending order. A user can checkout the calendar year nodes and manually add dates through the System Date editor or through the System Date Generation Wizard. A user can double click the node to view the calender year details.
VersionHistory contains the system dates for all calendar codes in a calendar year. The CurrentIndicator is not modified by any additions or updates to AsSystemDate.
System Editor: In the editor, the user can enter a date that does not belong to the calendar year that has been opened. When the data is checked in, the system will match the dates to appropriate calendar years and advance the version history for each calendar year for which the new data is added. Multiple version histories can be advanced in a single checkin.
The user is not allowed to duplicate an existing system date while the date is displayed in the editor. When a user selects a calendar code, the editor is refreshed with the system dates for the chosen calendar code.
Generation Wizard: The wizard allows a user to create dates for more than one calendar year. The system will match the dates to appropriate calendar years and advance version history for each calendar year for which the new data is added. Multiple version histories can be advanced in a single checkin.
When a user adds a new calendar node to the parent System Date node, the System Date node is refreshed to display the new calendar year node. The wizard validates that no system date is duplicated for the chosen calendar.
Version History: Palette adds a version history folder to each calendar year node for each checkin and saves a record to IvsVersion, IvsVersionHistory and IvsVersionField. A single checkin may save multiple records to the AsSystemDate table.
IvsVersion
The table saves the following details for a System date:
- A text which is a concatenation of the calendar year, "_" and "System Date" is persisted as the RuleGUID. For example, 2019_System Date
- VersionNumber, RuleTypeCode, ClientNumber, LastModifiedBy and LastModifiedGMT. For column descriptions, refer IvsVersion table.
IvsVersionHistory
The table saves the following details:
- A text which is a concatenation of the calendar year, "_" and "System Date" is persisted as the RuleGUID. For example, 2019_System Date.
- VersionGUID, Environment, Track, ActionTypeCode, LastModifiedBy, and LastModifiedGMT details of System Date. For column descriptions, refer IvsVersionHistory table.
IvsVersionField
In this table, the record is saved with an associated VersionGUID from IvsVersion; two XML documents contains all SystemDate records for the calendar year and the dynamic field data related to them. Each data record for the calendar year in AsSystemDate is saved in an XML document as follows:
| Field Name | Description |
| XMLData |
The XML document contains the data from the value saved in the XMLDataValue column (FieldTypeCode = 05). |
System Date data is saved in an XML document as follows:
<SystemDates>
<SystemDate SYSTEMDATEGUID="[guid]">
<Action>[None]</Action>
<SystemDateGUID>[guid]</SystemDateGUID>
<BusinessDayIndicator>[Y | N]</BusinessDayIndicator>
<CurrentIndicator>[Y | N]</CurrentIndicator>
<MonthEndIndicator>[Y | N]</MonthEndIndicator>
<QuarterEndIndicator>[Y | N]</QuarterEndIndicator>
<YearEndIndicator>[Y | N]</YearEndIndicator>
<CalendarCode>[code value]</CalendarCode>
<SystemDate>[date]</SystemDate>
<NextSystemDate>[date]</NextSystemDate>
<PreviousSystemDate>[date]</PreviousSystemDate>
<Fields>
<Field>
<Name>[field name]</Name>
<Value>[field value]</Value>
</Field>
<Field>...</Field>
</Fields>
</SystemDate>
<SystemDate>...</SystemDate>
</SystemDates>
|
Element and Attribute Description of <SystemDates>
| Element | Parent Element | Attribute | Description | Values |
| <SystemDates> | Opening element for a collection of system date records for all calendars in a single calendar year. | |||
| <SystemDate> | <SystemDates> |
Required, Repeatable: Opening element for a specific system date record. |
||
| <SystemDate> | SYSTEMDATEGUID |
Required: Unique ID for the system date record. |
GUID | |
| <Action> | <SystemDate> |
Required: This is always valued as "None". |
None | |
| <SystemDateGUID> | <SystemDate> |
Required: Unique ID for the system date record. |
GUID | |
| <BusinessDayIndicator> | <SystemDate> |
Required: Value of the BusinessDayIndicator. |
Y | N | |
| <CurrentIndicator> | <SystemDate> |
Required: Value of the CurrentIndicator. |
Y | N | |
| <MonthEndIndicator> | <SystemDate> |
Required: Value of the MonthEndIndicator. |
Y | N | |
| <QuarterEndIndicator> | <SystemDate> |
Required: Value of the QuarterEndIndicator. |
Y | N | |
| <YearEndIndicator> | <SystemDate> |
Required: Value of the YearEndIndicator. |
Y | N | |
| <CalendarCode> | <SystemDate> |
Required: The code value for the calendar. |
code value(AsCodeCalendar) | |
| <SystemDate> | <SystemDate> |
Required: The system date value for the record. |
date | |
| <NextSystemDate> | <SystemDate> |
Required: The next system date when dates are placed in ascending order. |
date | |
| <PreviousSystemDate> | <SystemDate> |
Required: The previous system date when dates are placed in ascending order. |
date | |
| <Fields> | <SystemDate> |
Optional: The opening element for a collection of dynamic fields associated to the system date record. |
||
| <Field> | <Fields> |
Required: The opening element for a dynamic field. |
||
| <Name> | <Field> |
Required: The name of a dynamic field. |
field name | |
| <Value> | <Field> |
Required: The value of the dynamic field. |
value |
Translations, IvsCodeRuleType =45
A user can access the Translation node from Admin Explorer>>Administration node to create a new locale under this node. The user can checkout the node to edit, delete or clone a locale. Each sub node under a locale contains a selectable file node and a version folder that includes a list of all versions with an option to Revert to this Version.
Each checkin can save multiple version history records to the AsTranslation table to IvsVersion, IvsVersionHistory and IvsVersionField.
IvsVersion
The table saves the following details for a Translation:
- The locale value (for example, en-US) is persisted as the RuleGUID.
- VersionNumber, RuleTypeCode, ClientNumber, LastModifiedBy and LastModifiedGMT. For column descriptions, refer IvsVersion table.
IvsVersionHistory
The table saves the following details:
- The locale value (example en-US) is persisted as the RuleGUID.
- VersionGUID, Environment, Track, ActionTypeCode, LastModifiedBy, and LastModifiedGMT details of Translation. For column descriptions, refer IvsVersionHistory table.
IvsVersionField
In this table, an XML document provides all translation records from AsTranslation as follows:
| Field Name | Description |
| TranslationGUID, Locale, TranslationKey, TranslationValue |
Contains translation record's TranslationValue as a data value. The XML document contains the data from the value saved in the XMLDataValue column (FieldTypeCode = 05). |
Translations data is saved in an XML document as follows:
<Translations RULEGUID="[locale value]">
<Translation>
<TranslationGUID>[guid]</TranslationGUID>
<Locale>[locale value]</Locale>
<TranslationKey>[key value]</TranslationKey>
<TranslationValue>[value]</TranslationValue>
</Translation>
<Translation>...</Translation>
</Translations>
|
Element and Attribute Description of <Translations>
| Element | Parent Element | Attribute | Description | Values |
| <Translations> | Opening element for the XML document. | |||
| <Translations> | RULEGUID |
Required: This element identifies the locale to which this data belongs. |
locale value | |
| <Translation> | <Translations> |
Required, Repeatable: An element providing the data of one translation record. |
||
| <TranslationGUID> | <Translation> |
Required: This is the GUID for the translation record. |
GUID | |
| <Locale> | <Translation> |
Required: The locale value for the translation record. |
locale value | |
| <TranslationKey> | <Translation> |
Required: The key value for the translation record. |
key name | |
| <TranslationValue> | <Translation> |
Required: The translation value for the translation record. |
value |